Resource URL: /platform/<<version=3>>/cloud/pools/<POOL>

    Overview: This resource applies the standard collection item pattern to
              individual OneFS cloud pools. POOL in the resource path is the
              pool name.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: Retrieve cloud pool information

       URL: GET /platform/<<version=3>>/cloud/pools/<POOL>

Query arguments:

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "pools": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "A group of cloud accounts which will be the destination for file stubbing", 
            "properties": {
              "vendor": {
                "type": "string", 
                "description": "A string identifier of the cloud services vendor"
              }, 
              "description": {
                "type": "string", 
                "description": "A brief description of this pool"
              }, 
              "birth_cluster_id": {
                "type": "string", 
                "description": "The guid of the cluster where this pool was created"
              }, 
              "state_details": {
                "type": "string", 
                "description": "Gives further information to describe the state of this pool"
              }, 
              "state": {
                "enum": [
                  "OK", 
                  "disabled"
                ], 
                "type": "string", 
                "description": "Indicates whether this pool is in a good state (\"OK\") or disabled (\"disabled\")"
              }, 
              "accounts": {
                "items": {
                  "type": "string"
                }, 
                "type": "array", 
                "description": "A list of valid names for the accounts in this pool.  There is currently only one account allowed per pool."
              }, 
              "type": {
                "enum": [
                  "isilon", 
                  "ecs", 
                  "virtustream", 
                  "azure", 
                  "s3", 
                  "google", 
                  "ran", 
                  "ecs2"
                ], 
                "type": "string", 
                "description": "The type of cloud protocol required.  E.g., \"isilon\" for EMC Isilon, \"ecs\" for EMC ECS Appliance, \"virtustream\" for Virtustream Storage Cloud, \"azure\" for Microsoft Azure, \"s3\" for Amazon S3 and \"google\" for Google Cloud Platform"
              }, 
              "id": {
                "type": "string", 
                "description": "A unique name for this pool"
              }, 
              "name": {
                "type": "string", 
                "description": "A unique name for this pool"
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }, 
        "resume": {
          "minLength": 0, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options)."
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify a cloud pool.  All fields are optional, but one or more must
            be supplied.

       URL: PUT /platform/<<version=3>>/cloud/pools/<POOL>

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "A group of cloud accounts which will be the destination for file stubbing", 
  "properties": {
    "vendor": {
      "type": "string", 
      "description": "A string identifier of the cloud services vendor"
    }, 
    "birth_cluster_id": {
      "type": "string", 
      "description": "The guid of the cluster where this pool was created"
    }, 
    "accounts": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "A list of valid names for the accounts in this pool.  There is currently only one account allowed per pool."
    }, 
    "description": {
      "type": "string", 
      "description": "A brief description of this pool"
    }, 
    "name": {
      "type": "string", 
      "description": "A unique name for this pool"
    }
  }
}

There is no JSON response body for this method.

********************************************************************************

Method DELETE: Delete a cloud pool.

          URL: DELETE /platform/<<version=3>>/cloud/pools/<POOL>

Query arguments:
acknowledge_force_delete=<string> A value of 1 acknowledges that the user is
                                  deleting data.

There is no JSON response body for this method.
